Repository navigation
docs: fill in missing replacement guidance for deprecated APIs - #1261
Open
GOODBOY008 wants to merge 1 commit into
Open
GOODBOY008 wants to merge 1 commit into
GOODBOY008 wants to merge 1 commit into
Conversation
Signed-off-by: gongzhongqiang <gongzhongqiang@apache.org>
Comment on lines
+83
to
+84
| * @param maxCacheActivateSize | ||
| * maximum size of the activated cache |
Contributor
There was a problem hiding this comment.
Please format it as a single line.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
A pass over all
@Deprecatedsites infesod-sheetmain code found a handful where the javadoc gives no usable replacement, or is malformed:WriteContext#getCurrentSheet()/#needHead()@deprecated please us e{@link ...}— typo breaks the tag textEhcache(Integer)ctorSimpleReadCacheSelector(Long, Integer)ctor@deprecatedtag naming the replacementSimpleReadCacheSelector.maxCacheActivateSizefieldmaxCacheActivateBatchCountonly as plain textStringImageConverterclass@see, no@deprecatedtagReadSheetHolder#getTotal()use: getApproximateTotalRowNumber()), not a tagChange
Javadoc-only edits filling in / fixing the
@deprecatedguidance at those six sites across five files. No code changes.Two notes on accuracy:
StringPathnameImageConverteris byte-for-byte the same implementation as the deprecatedStringImageConverter(both read a local file viaFileUtils.readFileToByteArray), so the guidance describes it as a rename rather than inventing a behavioural difference; andSimpleReadCacheSelector's replacement is the no-arg constructor plussetMaxCacheActivateBatchCount(...)because no such constructor exists yet.Scope
Deliberately limited to sites with missing or broken guidance. Sites that already carry correct
@deprecatedtags (theEasyExcel/FastExcel/FastExcelFactoryfacades,AnalysisContext,ExcelReader,Font, the fourAbstract*WriteHandlerbases,AbstractIgnoreExceptionReadListener,ExcelWriteHeadProperty) are untouched.ExcelBuilderandAbstractExcelWriterParameterBuilderalso contain deprecated members but are excluded here — #1181 already rewrites their javadoc (including the@deprecatedtags); this PR avoids colliding with it.Verification
Javadoc-only diff:
5 files changed, 13 insertions(+), 4 deletions(-).